Skip to content

Conversation

@BillWagner
Copy link
Member

@BillWagner BillWagner commented Jan 14, 2025

Fix a number of issues related to constructor articles and coding conventions. This may be easier to review commit by commit:

  1. Fix small open issues with related articles: 
  1. Fix remaining open issues:
  1. Code review. Update code based on our current style guide.
  2. Grammar check and edit pass on all markdown articles.

Internal previews

📄 File 🔗 Preview link
docs/csharp/fundamentals/coding-style/coding-conventions.md Common C# code conventions
docs/csharp/programming-guide/classes-and-structs/constructors.md "Constructors"
docs/csharp/programming-guide/classes-and-structs/using-constructors.md Use constructors (C# programming guide)
docs/csharp/tutorials/top-level-statements.md docs/csharp/tutorials/top-level-statements

@BillWagner BillWagner requested a review from a team as a code owner January 14, 2025 21:48
@dotnetrepoman dotnetrepoman bot added this to the January 2025 milestone Jan 14, 2025
@dotnet-policy-service dotnet-policy-service bot added okr-freshness OKR: Freshness of content okr-quality Content-quality KR: Concerns article defects (bugs), freshness, or build warnings. dotnet-csharp/svc fundamentals/subsvc labels Jan 14, 2025
@BillWagner BillWagner force-pushed the 13-coding-conventions branch 3 times, most recently from 5f0bc6f to 0ef4f40 Compare January 14, 2025 22:35
@BillWagner BillWagner marked this pull request as draft January 15, 2025 14:07
- dotnet#33341 already addressed in dotnet#36428.
- Fixes dotnet#37294: Add text that the shortened format is valid only when the runtime type matches the variable type.
- Fixes dotnet#37295: Don't use `ID` in the sample.
- Fixes dotnet#37296: Fix nullable warnings. Other issue comments are incorrect.
- Fixes dotnet#41748: Change the sample so the constructor is relevant.
- Fixes dotnet#42858: Add an explanation on declaring variables in top level statements.
@BillWagner BillWagner force-pushed the 13-coding-conventions branch from 0ef4f40 to 040dba3 Compare January 15, 2025 14:50
- Fixes dotnet#43838: Add notes for collection expressions and using primary constructors. Include naming recommendations.
- Fixes dotnet#43839  Update the overview of constructors to include information on primary constructors.
@BillWagner BillWagner force-pushed the 13-coding-conventions branch from a156ae2 to 29c3905 Compare January 15, 2025 18:43
Fix any style issues with the current code.
I also caught a couple sample bits that I'd neglected in the previous commit.
@BillWagner BillWagner marked this pull request as ready for review January 15, 2025 22:11
@BillWagner BillWagner requested a review from gewarren January 15, 2025 22:11
Co-authored-by: Genevieve Warren <[email protected]>
@BillWagner BillWagner enabled auto-merge (squash) January 17, 2025 19:53
@BillWagner BillWagner merged commit 0490d52 into dotnet:main Jan 17, 2025
8 checks passed
@BillWagner BillWagner deleted the 13-coding-conventions branch January 17, 2025 20:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dotnet-csharp/svc fundamentals/subsvc okr-freshness OKR: Freshness of content okr-quality Content-quality KR: Concerns article defects (bugs), freshness, or build warnings.

Projects

None yet

2 participants